Skip to main content

VASelector

A common component to display a checkbox with text

NameTypeDefault ValueRequiredDescription
selectorTypeSelectorTypeSelectorType.CheckboxNorender checkbox or radio button
selectedbooleanYeswhen true displays the filled checkbox/radio , when false displays the empty checkbox/radio
onSelectionChange(selected: boolean) => voidYessets the value of selected on click of the checkbox/radio
labelKeystringYestranslated labelKey displayed next to the checkbox/radio
labelArgs{ [key: string]: string; }Nooptional arguments to pass in with the labelKey during translation
disabledbooleanNooptional boolean that disables the VASelector/radio when set to true
a11yLabelstringNooptional accessibilityLabel
a11yHintstringNooptional accessibilityHint
errorstringNooptional error to display for the checkbox
setError(value?: string) => voidNooptional callback to set the error message
isRequiredFieldbooleanNooptional boolean that marks the component as required
testIDstringNoOptional TestID